<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="null" lang="null">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" /><title>Pattern xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/jaxen/pattern/Pattern.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em class="comment">/*</em>
<a name="2" href="#2">2</a>   <em class="comment"> * $Header$</em>
<a name="3" href="#3">3</a>   <em class="comment"> * $Revision: 1134 $</em>
<a name="4" href="#4">4</a>   <em class="comment"> * $Date: 2006-04-07 10:11:52 -0700 (Fri, 07 Apr 2006) $</em>
<a name="5" href="#5">5</a>   <em class="comment"> *</em>
<a name="6" href="#6">6</a>   <em class="comment"> * ====================================================================</em>
<a name="7" href="#7">7</a>   <em class="comment"> *</em>
<a name="8" href="#8">8</a>   <em class="comment"> * Copyright 2000-2002 bob mcwhirter &amp; James Strachan.</em>
<a name="9" href="#9">9</a>   <em class="comment"> * All rights reserved.</em>
<a name="10" href="#10">10</a>  <em class="comment"> *</em>
<a name="11" href="#11">11</a>  <em class="comment"> * Redistribution and use in source and binary forms, with or without</em>
<a name="12" href="#12">12</a>  <em class="comment"> * modification, are permitted provided that the following conditions are</em>
<a name="13" href="#13">13</a>  <em class="comment"> * met:</em>
<a name="14" href="#14">14</a>  <em class="comment"> * </em>
<a name="15" href="#15">15</a>  <em class="comment"> *   * Redistributions of source code must retain the above copyright</em>
<a name="16" href="#16">16</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer.</em>
<a name="17" href="#17">17</a>  <em class="comment"> * </em>
<a name="18" href="#18">18</a>  <em class="comment"> *   * Redistributions in binary form must reproduce the above copyright</em>
<a name="19" href="#19">19</a>  <em class="comment"> *     notice, this list of conditions and the following disclaimer in the</em>
<a name="20" href="#20">20</a>  <em class="comment"> *     documentation and/or other materials provided with the distribution.</em>
<a name="21" href="#21">21</a>  <em class="comment"> * </em>
<a name="22" href="#22">22</a>  <em class="comment"> *   * Neither the name of the Jaxen Project nor the names of its</em>
<a name="23" href="#23">23</a>  <em class="comment"> *     contributors may be used to endorse or promote products derived </em>
<a name="24" href="#24">24</a>  <em class="comment"> *     from this software without specific prior written permission.</em>
<a name="25" href="#25">25</a>  <em class="comment"> * </em>
<a name="26" href="#26">26</a>  <em class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS</em>
<a name="27" href="#27">27</a>  <em class="comment"> * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED</em>
<a name="28" href="#28">28</a>  <em class="comment"> * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</em>
<a name="29" href="#29">29</a>  <em class="comment"> * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER</em>
<a name="30" href="#30">30</a>  <em class="comment"> * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</em>
<a name="31" href="#31">31</a>  <em class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</em>
<a name="32" href="#32">32</a>  <em class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</em>
<a name="33" href="#33">33</a>  <em class="comment"> * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</em>
<a name="34" href="#34">34</a>  <em class="comment"> * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</em>
<a name="35" href="#35">35</a>  <em class="comment"> * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</em>
<a name="36" href="#36">36</a>  <em class="comment"> * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</em>
<a name="37" href="#37">37</a>  <em class="comment"> *</em>
<a name="38" href="#38">38</a>  <em class="comment"> * ====================================================================</em>
<a name="39" href="#39">39</a>  <em class="comment"> * This software consists of voluntary contributions made by many </em>
<a name="40" href="#40">40</a>  <em class="comment"> * individuals on behalf of the Jaxen Project and was originally </em>
<a name="41" href="#41">41</a>  <em class="comment"> * created by bob mcwhirter &lt;bob@werken.com> and </em>
<a name="42" href="#42">42</a>  <em class="comment"> * James Strachan &lt;jstrachan@apache.org>.  For more information on the </em>
<a name="43" href="#43">43</a>  <em class="comment"> * Jaxen Project, please see &lt;<a href="http://www.jaxen.org/" target="alexandria_uri">http://www.jaxen.org/</a>>.</em>
<a name="44" href="#44">44</a>  <em class="comment"> * </em>
<a name="45" href="#45">45</a>  <em class="comment"> * $Id: Pattern.java 1134 2006-04-07 17:11:52Z elharo $</em>
<a name="46" href="#46">46</a>  <em class="comment"> */</em>
<a name="47" href="#47">47</a>  
<a name="48" href="#48">48</a>  <strong>package</strong> org.jaxen.pattern;
<a name="49" href="#49">49</a>  
<a name="50" href="#50">50</a>  <strong>import</strong> org.jaxen.Context;
<a name="51" href="#51">51</a>  <strong>import</strong> org.jaxen.JaxenException;
<a name="52" href="#52">52</a>  
<a name="53" href="#53">53</a>  <em>/**</em><em> &lt;p>&lt;code>Pattern&lt;/code> defines the behaviour for pattern in</em>
<a name="54" href="#54">54</a>  <em>  * the XSLT processing model.&lt;/p></em>
<a name="55" href="#55">55</a>  <em>  *</em>
<a name="56" href="#56">56</a>  <em>  * @author &lt;a href="<a href="mailto:jstrachan@apache.org" target="alexandria_uri">mailto:jstrachan@apache.org</a>">James Strachan&lt;/a></em>
<a name="57" href="#57">57</a>  <em>  * @version $Revision: 1134 $</em>
<a name="58" href="#58">58</a>  <em>  */</em>
<a name="59" href="#59">59</a>  <strong>public</strong> <strong>abstract</strong> <strong>class</strong> <a href="../../../org/jaxen/pattern/Pattern.html">Pattern</a> {
<a name="60" href="#60">60</a>  
<a name="61" href="#61">61</a>      <em class="comment">// These node numbers are compatible with both DOM and dom4j's node types</em>
<a name="62" href="#62">62</a>      <em>/**</em><em> Matches Element nodes */</em>
<a name="63" href="#63">63</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> ELEMENT_NODE = 1;
<a name="64" href="#64">64</a>      <em>/**</em><em> Matches attribute nodes */</em>
<a name="65" href="#65">65</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> ATTRIBUTE_NODE = 2;
<a name="66" href="#66">66</a>      <em>/**</em><em> Matches text nodes */</em>
<a name="67" href="#67">67</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> TEXT_NODE = 3;
<a name="68" href="#68">68</a>      <em>/**</em><em> Matches CDATA section nodes */</em>
<a name="69" href="#69">69</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> CDATA_SECTION_NODE = 4;
<a name="70" href="#70">70</a>      <em>/**</em><em> Matches entity reference nodes */</em>
<a name="71" href="#71">71</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> ENTITY_REFERENCE_NODE = 5;
<a name="72" href="#72">72</a>      <em>/**</em><em> Matches entity nodes */</em>
<a name="73" href="#73">73</a>      <em class="comment">//public static final short ENTITY_NODE = 6;</em>
<a name="74" href="#74">74</a>      <em>/**</em><em> Matches ProcessingInstruction */</em>
<a name="75" href="#75">75</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> PROCESSING_INSTRUCTION_NODE = 7;
<a name="76" href="#76">76</a>      <em>/**</em><em> Matches comment nodes */</em>
<a name="77" href="#77">77</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> COMMENT_NODE = 8;
<a name="78" href="#78">78</a>      <em>/**</em><em> Matches document nodes */</em>
<a name="79" href="#79">79</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> DOCUMENT_NODE = 9;
<a name="80" href="#80">80</a>      <em>/**</em><em> Matches DocumentType nodes */</em>
<a name="81" href="#81">81</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> DOCUMENT_TYPE_NODE = 10;
<a name="82" href="#82">82</a>      <em class="comment">//public static final short DOCUMENT_FRAGMENT_NODE = 11;</em>
<a name="83" href="#83">83</a>      <em class="comment">//public static final short NOTATION_NODE = 12;</em>
<a name="84" href="#84">84</a>      
<a name="85" href="#85">85</a>      <em>/**</em><em> Matches a Namespace Node */</em>
<a name="86" href="#86">86</a>      <em class="comment">// This has the same value as the DOM Level 3 XPathNamespace type</em>
<a name="87" href="#87">87</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> NAMESPACE_NODE = 13;
<a name="88" href="#88">88</a>      
<a name="89" href="#89">89</a>      <em>/**</em><em> Does not match any valid node */</em>
<a name="90" href="#90">90</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> UNKNOWN_NODE = 14;
<a name="91" href="#91">91</a>      
<a name="92" href="#92">92</a>      <em>/**</em><em> The maximum number of node types for sizing purposes */</em>
<a name="93" href="#93">93</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> MAX_NODE_TYPE = 14;
<a name="94" href="#94">94</a>  
<a name="95" href="#95">95</a>      <em>/**</em><em> Matches any node */</em>
<a name="96" href="#96">96</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> ANY_NODE = 0;
<a name="97" href="#97">97</a>      
<a name="98" href="#98">98</a>      <em>/**</em><em> Matches no nodes */</em>
<a name="99" href="#99">99</a>      <strong>public</strong> <strong>static</strong> <strong>final</strong> <strong>short</strong> NO_NODE = 14;
<a name="100" href="#100">100</a>     
<a name="101" href="#101">101</a>     
<a name="102" href="#102">102</a>     <em>/**</em><em> </em>
<a name="103" href="#103">103</a> <em>     * </em>
<a name="104" href="#104">104</a> <em>     * @param node ????</em>
<a name="105" href="#105">105</a> <em>     * @param context ????</em>
<a name="106" href="#106">106</a> <em>     * @return true if the pattern matches the given node</em>
<a name="107" href="#107">107</a> <em>     * @throws JaxenException  if ????</em>
<a name="108" href="#108">108</a> <em>      */</em>
<a name="109" href="#109">109</a>     <strong>public</strong> <strong>abstract</strong> <strong>boolean</strong> matches( Object node, Context context ) throws JaxenException;
<a name="110" href="#110">110</a>     
<a name="111" href="#111">111</a>     <em>/**</em><em> Returns the default resolution policy of the pattern according to the</em>
<a name="112" href="#112">112</a> <em>      * &lt;a href="<a href="http://www.w3.org/TR/xslt" target="alexandria_uri">http://www.w3.org/TR/xslt</a>#conflict"></em>
<a name="113" href="#113">113</a> <em>      * XSLT conflict resolution rules&lt;/a>.</em>
<a name="114" href="#114">114</a> <em>      *  </em>
<a name="115" href="#115">115</a> <em>     * @return 0.5; the default priority defined in XSLT</em>
<a name="116" href="#116">116</a> <em>     * </em>
<a name="117" href="#117">117</a> <em>     * @see &lt;a href="<a href="http://www.w3.org/TR/xslt" target="alexandria_uri">http://www.w3.org/TR/xslt</a>#conflict" target="_top">Section 5.5 of the XSLT specification&lt;/a></em>
<a name="118" href="#118">118</a> <em>      * </em>
<a name="119" href="#119">119</a> <em>      */</em>
<a name="120" href="#120">120</a>     <strong>public</strong> <strong>double</strong> getPriority() 
<a name="121" href="#121">121</a>     {
<a name="122" href="#122">122</a>         <strong>return</strong> 0.5;
<a name="123" href="#123">123</a>     }
<a name="124" href="#124">124</a>     
<a name="125" href="#125">125</a>     <em>/**</em><em> If this pattern is a union pattern then this</em>
<a name="126" href="#126">126</a> <em>      * method should return an array of patterns which</em>
<a name="127" href="#127">127</a> <em>      * describe the union pattern, which should contain more than one pattern.</em>
<a name="128" href="#128">128</a> <em>      * Otherwise this method should return null.</em>
<a name="129" href="#129">129</a> <em>      *</em>
<a name="130" href="#130">130</a> <em>      * @return an array of the patterns which make up this union pattern</em>
<a name="131" href="#131">131</a> <em>      * or null if this pattern is not a union pattern</em>
<a name="132" href="#132">132</a> <em>      */</em>
<a name="133" href="#133">133</a>     <strong>public</strong> <a href="../../../org/jaxen/pattern/Pattern.html">Pattern</a>[] getUnionPatterns() 
<a name="134" href="#134">134</a>     {
<a name="135" href="#135">135</a>         <strong>return</strong> <strong>null</strong>;
<a name="136" href="#136">136</a>     }
<a name="137" href="#137">137</a> 
<a name="138" href="#138">138</a>     
<a name="139" href="#139">139</a>     <em>/**</em><em> </em>
<a name="140" href="#140">140</a> <em>     * Returns the type of node the pattern matches.</em>
<a name="141" href="#141">141</a> <em>     * </em>
<a name="142" href="#142">142</a> <em>     * @return &lt;code>ANY_NODE&lt;/code> unless overridden</em>
<a name="143" href="#143">143</a> <em>      */</em>
<a name="144" href="#144">144</a>     <strong>public</strong> <strong>short</strong> getMatchType() 
<a name="145" href="#145">145</a>     {
<a name="146" href="#146">146</a>         <strong>return</strong> ANY_NODE;
<a name="147" href="#147">147</a>     }
<a name="148" href="#148">148</a> 
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>     <em>/**</em><em> For patterns which only match an ATTRIBUTE_NODE or an </em>
<a name="151" href="#151">151</a> <em>      * ELEMENT_NODE then this pattern may return the name of the</em>
<a name="152" href="#152">152</a> <em>      * element or attribute it matches. This allows a more efficient</em>
<a name="153" href="#153">153</a> <em>      * rule matching algorithm to be performed, rather than a brute </em>
<a name="154" href="#154">154</a> <em>      * force approach of evaluating every pattern for a given Node.</em>
<a name="155" href="#155">155</a> <em>      *</em>
<a name="156" href="#156">156</a> <em>      * @return the name of the element or attribute this pattern matches</em>
<a name="157" href="#157">157</a> <em>      * or null if this pattern matches any or more than one name</em>
<a name="158" href="#158">158</a> <em>      */</em>
<a name="159" href="#159">159</a>     <strong>public</strong> String getMatchesNodeName() 
<a name="160" href="#160">160</a>     {
<a name="161" href="#161">161</a>         <strong>return</strong> <strong>null</strong>;
<a name="162" href="#162">162</a>     }
<a name="163" href="#163">163</a>     
<a name="164" href="#164">164</a>     
<a name="165" href="#165">165</a>     <strong>public</strong> <a href="../../../org/jaxen/pattern/Pattern.html">Pattern</a> simplify() 
<a name="166" href="#166">166</a>     {
<a name="167" href="#167">167</a>         <strong>return</strong> <strong>this</strong>;
<a name="168" href="#168">168</a>     }
<a name="169" href="#169">169</a>     
<a name="170" href="#170">170</a>     <em>/**</em><em> Returns a textual representation of this pattern</em>
<a name="171" href="#171">171</a> <em>     * </em>
<a name="172" href="#172">172</a> <em>     * @return the usual string form of this XSLT pattern</em>
<a name="173" href="#173">173</a> <em>     */</em>
<a name="174" href="#174">174</a>     <strong>public</strong> <strong>abstract</strong> String getText();
<a name="175" href="#175">175</a> 
<a name="176" href="#176">176</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

